Skip to main content

List Containers with Rightsizing Recommendations

GET 
/rightsizing/containers

Retrieve a list of containers with their current resource requests, recommended resource requests, efficiency metrics, and potential cost savings. Supports filtering by cluster, namespace, labels, status, and more.

Request​

Query Parameters

    page_number integer

    Default value: 1

    page_size integer

    Default value: 10

    sort_by any
    order any
    days integer

    Default value: 30

    Number of days to analyze for recommendations

    cluster_id integer[]
    cluster_arn string[]

    List of cluster ARNs

    namespace string[]
    name string[]

    Container names to filter by

    labels string[]
    status ContainerStatus[]

    Possible values: [running, failed, succeeded, pending, exited]

    owner_name string[]

    Names of the controllers

    owner_kind string[]

    Kinds of the controllers

    name_search string

    Search by container name

    auto_rightsize boolean

    Filter by auto-rightsizing status

    policy_id integer[]

    List of policy IDs to filter by

    csv_export boolean

    Export results as CSV

Responses​

Successfully retrieved containers list

Schema

    total_rows Total Rows (integer)required

    results

    object[]

    required

  • Array [

    • id Id (integer)required
    name Name (string)required
    efficiency Efficiency (integer)required
    cpu_request Cpu Request (number)
    recommended_cpu_request Recommended Cpu Request (number)
    memory_request Memory Request (number)
    memory_request_unit Memory Request Unit (string)
    recommended_memory_request Recommended Memory Request (number)
    recommended_memory_request_unit Recommended Memory Request Unit (string)
    cpu_recommended_percentiles object

    Default value: [object Object]

    memory_recommended_percentiles object

    Default value: [object Object]

    cpu_default_recommended_percentile Cpu Default Recommended Percentile (string)
    memory_default_recommended_percentile Memory Default Recommended Percentile (string)
    owner_kind Owner Kind (string)
    owner_name Owner Name (string)
    cost Cost (number)required
    savings Savings (number)
    policy_id Policy Id (integer)
    policy_name Policy Name (string)

    The name of the rightsizing policy assigned to this container, if any.

    auto_rightsize Auto Rightsize (boolean)
    last_seen Last Seen (string)
    namespace Namespace (string)
    labels object

    Default value: [object Object]

    status Status (string)required
    schedule_id Schedule Id (integer)

    The ID of the rightsizing schedule assigned to this container, if any.

  • ]

Loading...